Ktor OpenAPI/Swagger 3 Generator/com.papsign.ktor.openapigen.route

Package-level declarations

Types

data class EndpointInfo(val summary: String? = null, val description: String? = null, val deprecated: Boolean? = null) : OperationModule, RouteOpenAPIModule

OpenAPIRoute

abstract class OpenAPIRoute<T : OpenAPIRoute<T>>(val ktorRoute: Route, val provider: CachingModuleProvider)

ResponseAnnotationStatusCode

object ResponseAnnotationStatusCode : StatusProvider, RouteOpenAPIModule

StatusCode

data class StatusCode(val code: HttpStatusCode) : StatusProvider, RouteOpenAPIModule

TagModule

class TagModule(val tags: Collection<APITag>) : TagProviderModule

ThrowsInfo

data class ThrowsInfo(val exceptions: List<APIException<*, *>>) : ThrowInfoProvider

Properties

application

val OpenAPIRoute<*>.application: Application

Functions

apiRouting

fun Application.apiRouting(config: NormalOpenAPIRoute.() -> Unit)

Wrapper for io.ktor.routing.routing to create the endpoints while configuring OpenAPI documentation at the same time.

fun Route.apiRouting(config: NormalOpenAPIRoute.() -> Unit)

Wrapper for io.ktor.server.routing.routing to create the endpoints while configuring OpenAPI documentation at the same time.

exitAPI

inline fun OpenAPIRoute<*>.exitAPI(crossinline fn: Route.() -> Unit)

info

fun info(summary: String? = null, description: String? = null, deprecated: Boolean? = null): EndpointInfo

Adds a summary, description and deprecation flag for the endpoint being configured

makeExceptionHandler

fun makeExceptionHandler(info: Array<out APIException<*, *>>): suspend PipelineContext<*, PipelineCall>.(t: Throwable) -> Unit

method

fun <TRoute : OpenAPIRoute<TRoute>> TRoute.method(method: HttpMethod): TRoute

inline fun <TRoute : OpenAPIRoute<TRoute>> TRoute.method(method: HttpMethod, crossinline fn: TRoute.() -> Unit)

Creates a new route matching the specified method

preHandle

inline fun <TParams : Any, TResponse : Any, TRequest : Any, TRoute : OpenAPIRoute<TRoute>> TRoute.preHandle(exampleResponse: TResponse? = null, exampleRequest: TRequest? = null, noinline handle: TRoute.() -> Unit)

provider

fun <TRoute : OpenAPIRoute<TRoute>> TRoute.provider(vararg content: ContentTypeProvider): TRoute

inline fun <TRoute : OpenAPIRoute<TRoute>> TRoute.provider(vararg content: ContentTypeProvider, crossinline fn: TRoute.() -> Unit)

Creates a new route matching the specified content

responseAnnotationStatus

fun responseAnnotationStatus(): ResponseAnnotationStatusCode

Success response status code of the endpoint will be derived from the @Response annotation

responseAnnotationStatus

inline fun <T : OpenAPIRoute<T>> T.responseAnnotationStatus(crossinline fn: T.() -> Unit)

Success response status code of the endpoints defined in the block will be derived from the @Response annotation

route

fun <T : OpenAPIRoute<T>> T.route(path: String): T

inline fun <TRoute : OpenAPIRoute<TRoute>> TRoute.route(path: String, crossinline fn: TRoute.() -> Unit)

Creates a new route matching the specified path

status

fun status(code: HttpStatusCode): StatusCode

fun status(code: Int): StatusCode

Sets the success response status code of the endpoint

status

inline fun <T : OpenAPIRoute<T>> T.status(code: HttpStatusCode, crossinline fn: T.() -> Unit)

inline fun <T : OpenAPIRoute<T>> T.status(code: Int, crossinline fn: T.() -> Unit)

Sets the success response status code of the endpoints defined in the block

tag

fun <TRoute : OpenAPIRoute<TRoute>> TRoute.tag(tag: APITag): TRoute

Applies a tag to all children of this route. Parameter tag should be an enum that inherits from APITag, check APITag description for an explanation.

inline fun <TRoute : OpenAPIRoute<TRoute>> TRoute.tag(tag: APITag, crossinline fn: TRoute.() -> Unit)

This method assigns an OpenAPI tag too all child routes defined inside fn. Parameter tag should be an enum that inherits from APITag, check APITag description for an explanation.